<!-- HTML header for doxygen 1.8.6-->
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">

<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta content="text/xhtml;charset=utf-8" http-equiv="Content-Type"/>
<meta content="IE=9" http-equiv="X-UA-Compatible"/>
<meta content="Doxygen 1.8.13" name="generator"/>
<title>OpenCV: cv::quality::QualitySSIM Class Reference</title>
<link href="../../opencv.ico" rel="shortcut icon" type="image/x-icon"/>
<link href="../../tabs.css" rel="stylesheet" type="text/css"/>
<script src="../../jquery.js" type="text/javascript"></script>
<script src="../../dynsections.js" type="text/javascript"></script>
<script src="../../tutorial-utils.js" type="text/javascript"></script>
<link href="../../search/search.css" rel="stylesheet" type="text/css"/>
<script src="../../search/searchdata.js" type="text/javascript"></script>
<script src="../../search/search.js" type="text/javascript"></script>
<script type="text/x-mathjax-config">
  MathJax.Hub.Config({
    extensions: ["tex2jax.js", "TeX/AMSmath.js", "TeX/AMSsymbols.js"],
    jax: ["input/TeX","output/HTML-CSS"],
});
//<![CDATA[
MathJax.Hub.Config(
{
  TeX: {
      Macros: {
          matTT: [ "\\[ \\left|\\begin{array}{ccc} #1 & #2 & #3\\\\ #4 & #5 & #6\\\\ #7 & #8 & #9 \\end{array}\\right| \\]", 9],
          fork: ["\\left\\{ \\begin{array}{l l} #1 & \\mbox{#2}\\\\ #3 & \\mbox{#4}\\\\ \\end{array} \\right.", 4],
          forkthree: ["\\left\\{ \\begin{array}{l l} #1 & \\mbox{#2}\\\\ #3 & \\mbox{#4}\\\\ #5 & \\mbox{#6}\\\\ \\end{array} \\right.", 6],
          forkfour: ["\\left\\{ \\begin{array}{l l} #1 & \\mbox{#2}\\\\ #3 & \\mbox{#4}\\\\ #5 & \\mbox{#6}\\\\ #7 & \\mbox{#8}\\\\ \\end{array} \\right.", 8],
          vecthree: ["\\begin{bmatrix} #1\\\\ #2\\\\ #3 \\end{bmatrix}", 3],
          vecthreethree: ["\\begin{bmatrix} #1 & #2 & #3\\\\ #4 & #5 & #6\\\\ #7 & #8 & #9 \\end{bmatrix}", 9],
          cameramatrix: ["#1 = \\begin{bmatrix} f_x & 0 & c_x\\\\ 0 & f_y & c_y\\\\ 0 & 0 & 1 \\end{bmatrix}", 1],
          distcoeffs: ["(k_1, k_2, p_1, p_2[, k_3[, k_4, k_5, k_6 [, s_1, s_2, s_3, s_4[, \\tau_x, \\tau_y]]]]) \\text{ of 4, 5, 8, 12 or 14 elements}"],
          distcoeffsfisheye: ["(k_1, k_2, k_3, k_4)"],
          hdotsfor: ["\\dots", 1],
          mathbbm: ["\\mathbb{#1}", 1],
          bordermatrix: ["\\matrix{#1}", 1]
      }
  }
}
);
//]]>
</script><script src="https://cdnjs.cloudflare.com/ajax/libs/mathjax/2.7.0/MathJax.js" type="text/javascript"></script>
<link href="../../doxygen.css" rel="stylesheet" type="text/css"/>
<link href="../../stylesheet.css" rel="stylesheet" type="text/css"/>
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<!--#include virtual="/google-search.html"-->
<table cellpadding="0" cellspacing="0">
 <tbody>
 <tr style="height: 56px;">
  <td id="projectlogo"><img alt="Logo" src="../../opencv-logo-small.png"/></td>
  <td style="padding-left: 0.5em;">
   <div id="projectname">OpenCV
    <span id="projectnumber">4.5.2</span>
   </div>
   <div id="projectbrief">Open Source Computer Vision</div>
  </td>
 </tr>
 </tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.13 -->
<script type="text/javascript">
var searchBox = new SearchBox("searchBox", "../../search",false,'Search');
</script>
<script src="../../menudata.js" type="text/javascript"></script>
<script src="../../menu.js" type="text/javascript"></script>
<script type="text/javascript">
$(function() {
  initMenu('../../',true,false,'search.php','Search');
  $(document).ready(function() { init_search(); });
});
</script>
<div id="main-nav"></div>
<!-- window showing the filter options -->
<div id="MSearchSelectWindow" onkeydown="return searchBox.OnSearchSelectKey(event)" onmouseout="return searchBox.OnSearchSelectHide()" onmouseover="return searchBox.OnSearchSelectShow()">
</div>
<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<iframe frameborder="0" id="MSearchResults" name="MSearchResults" src="javascript:void(0)">
</iframe>
</div>
<div class="navpath" id="nav-path">
  <ul>
<li class="navelem"><a class="el" href="../../d2/d75/namespacecv.html">cv</a></li><li class="navelem"><a class="el" href="../../da/d0b/namespacecv_1_1quality.html">quality</a></li><li class="navelem"><a class="el" href="../../d9/db5/classcv_1_1quality_1_1QualitySSIM.html">QualitySSIM</a></li>  </ul>
</div>
</div><!-- top -->
<div class="header">
  <div class="summary">
<a href="#nested-classes">Classes</a> |
<a href="#pub-methods">Public Member Functions</a> |
<a href="#pub-static-methods">Static Public Member Functions</a> |
<a href="#pro-methods">Protected Member Functions</a> |
<a href="#pro-attribs">Protected Attributes</a> |
<a href="../../d7/dad/classcv_1_1quality_1_1QualitySSIM-members.html">List of all members</a>  </div>
  <div class="headertitle">
<div class="title">cv::quality::QualitySSIM Class Reference</div>  </div>
</div><!--header-->
<div class="contents">
<p>Full reference structural similarity algorithm <a href="https://en.wikipedia.org/wiki/Structural_similarity">https://en.wikipedia.org/wiki/Structural_similarity</a>.  
 <a href="../../d9/db5/classcv_1_1quality_1_1QualitySSIM.html#details">More...</a></p>
<p><code>#include &lt;opencv2/quality/qualityssim.hpp&gt;</code></p>
<div class="dynheader">
Inheritance diagram for cv::quality::QualitySSIM:</div>
<div class="dyncontent">
 <div class="center">
  <img alt="" src="../../d9/db5/classcv_1_1quality_1_1QualitySSIM.png" usemap="#cv::quality::QualitySSIM_map"/>
  <map id="cv::quality::QualitySSIM_map" name="cv::quality::QualitySSIM_map">
<area alt="cv::quality::QualityBase" coords="0,56,144,80" href="../../da/d83/classcv_1_1quality_1_1QualityBase.html" shape="rect"/>
<area alt="cv::Algorithm" coords="0,0,144,24" href="../../d3/d46/classcv_1_1Algorithm.html" shape="rect" title="This is a base class for all more or less complex algorithms in OpenCV. "/>
</map>
 </div></div>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="nested-classes"></a>
Classes</h2></td></tr>
<tr class="memitem:"><td align="right" class="memItemLeft" valign="top">struct  </td><td class="memItemRight" valign="bottom"><a class="el" href="../../dd/dcb/structcv_1_1quality_1_1QualitySSIM_1_1__mat__data.html">_mat_data</a></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a>
Public Member Functions</h2></td></tr>
<tr class="memitem:ac527e54b09d8f8375be2403426724709"><td align="right" class="memItemLeft" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="../../d9/db5/classcv_1_1quality_1_1QualitySSIM.html#ac527e54b09d8f8375be2403426724709">clear</a> () <a class="el" href="../../db/de0/group__core__utils.html#ga4d89d63e402ef9ddc48e18e21180fe4a">CV_OVERRIDE</a></td></tr>
<tr class="memdesc:ac527e54b09d8f8375be2403426724709"><td class="mdescLeft"> </td><td class="mdescRight">Implements <a class="el" href="../../d3/d46/classcv_1_1Algorithm.html#aec9c965448e4dc851d7cacd3abd84cd1" title="Clears the algorithm state. ">Algorithm::clear()</a>  <a href="#ac527e54b09d8f8375be2403426724709">More...</a><br/></td></tr>
<tr class="separator:ac527e54b09d8f8375be2403426724709"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a49d5ecc72e83b8876c8293244c3667e4"><td align="right" class="memItemLeft" valign="top"><a class="el" href="../../dc/d84/group__core__basic.html#ga599fe92e910c027be274233eccad7beb">cv::Scalar</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="../../d9/db5/classcv_1_1quality_1_1QualitySSIM.html#a49d5ecc72e83b8876c8293244c3667e4">compute</a> (<a class="el" href="../../dc/d84/group__core__basic.html#ga353a9de602fe76c709e12074a6f362ba">InputArray</a> cmp) <a class="el" href="../../db/de0/group__core__utils.html#ga4d89d63e402ef9ddc48e18e21180fe4a">CV_OVERRIDE</a></td></tr>
<tr class="memdesc:a49d5ecc72e83b8876c8293244c3667e4"><td class="mdescLeft"> </td><td class="mdescRight">Computes SSIM.  <a href="#a49d5ecc72e83b8876c8293244c3667e4">More...</a><br/></td></tr>
<tr class="separator:a49d5ecc72e83b8876c8293244c3667e4"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a85d066936579d6c18aa6a981be331283"><td align="right" class="memItemLeft" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="../../d9/db5/classcv_1_1quality_1_1QualitySSIM.html#a85d066936579d6c18aa6a981be331283">empty</a> () const <a class="el" href="../../db/de0/group__core__utils.html#ga4d89d63e402ef9ddc48e18e21180fe4a">CV_OVERRIDE</a></td></tr>
<tr class="memdesc:a85d066936579d6c18aa6a981be331283"><td class="mdescLeft"> </td><td class="mdescRight">Implements <a class="el" href="../../d3/d46/classcv_1_1Algorithm.html#ab6a18f1825475643e94381697d413972" title="Returns true if the Algorithm is empty (e.g. in the very beginning or after unsuccessful read...">Algorithm::empty()</a>  <a href="#a85d066936579d6c18aa6a981be331283">More...</a><br/></td></tr>
<tr class="separator:a85d066936579d6c18aa6a981be331283"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="inherit_header pub_methods_classcv_1_1quality_1_1QualityBase"><td colspan="2" onclick="javascript:toggleInherit('pub_methods_classcv_1_1quality_1_1QualityBase')"><img alt="-" src="../../closed.png"/> Public Member Functions inherited from <a class="el" href="../../da/d83/classcv_1_1quality_1_1QualityBase.html">cv::quality::QualityBase</a></td></tr>
<tr class="memitem:ae8c9f83c6a95a41594e5027f72528e58 inherit pub_methods_classcv_1_1quality_1_1QualityBase"><td align="right" class="memItemLeft" valign="top">virtual </td><td class="memItemRight" valign="bottom"><a class="el" href="../../da/d83/classcv_1_1quality_1_1QualityBase.html#ae8c9f83c6a95a41594e5027f72528e58">~QualityBase</a> ()=default</td></tr>
<tr class="memdesc:ae8c9f83c6a95a41594e5027f72528e58 inherit pub_methods_classcv_1_1quality_1_1QualityBase"><td class="mdescLeft"> </td><td class="mdescRight">Destructor.  <a href="../../da/d83/classcv_1_1quality_1_1QualityBase.html#ae8c9f83c6a95a41594e5027f72528e58">More...</a><br/></td></tr>
<tr class="separator:ae8c9f83c6a95a41594e5027f72528e58 inherit pub_methods_classcv_1_1quality_1_1QualityBase"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:aabc53c22c35c0eaffe20c03989ae2d3f inherit pub_methods_classcv_1_1quality_1_1QualityBase"><td align="right" class="memItemLeft" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="../../da/d83/classcv_1_1quality_1_1QualityBase.html#aabc53c22c35c0eaffe20c03989ae2d3f">getQualityMap</a> (<a class="el" href="../../dc/d84/group__core__basic.html#gaad17fda1d0f0d1ee069aebb1df2913c0">OutputArray</a> dst) const</td></tr>
<tr class="memdesc:aabc53c22c35c0eaffe20c03989ae2d3f inherit pub_methods_classcv_1_1quality_1_1QualityBase"><td class="mdescLeft"> </td><td class="mdescRight">Returns output quality map that was generated during computation, if supported by the algorithm.  <a href="../../da/d83/classcv_1_1quality_1_1QualityBase.html#aabc53c22c35c0eaffe20c03989ae2d3f">More...</a><br/></td></tr>
<tr class="separator:aabc53c22c35c0eaffe20c03989ae2d3f inherit pub_methods_classcv_1_1quality_1_1QualityBase"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="inherit_header pub_methods_classcv_1_1Algorithm"><td colspan="2" onclick="javascript:toggleInherit('pub_methods_classcv_1_1Algorithm')"><img alt="-" src="../../closed.png"/> Public Member Functions inherited from <a class="el" href="../../d3/d46/classcv_1_1Algorithm.html">cv::Algorithm</a></td></tr>
<tr class="memitem:a827c8b2781ed17574805f373e6054ff1 inherit pub_methods_classcv_1_1Algorithm"><td align="right" class="memItemLeft" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="../../d3/d46/classcv_1_1Algorithm.html#a827c8b2781ed17574805f373e6054ff1">Algorithm</a> ()</td></tr>
<tr class="separator:a827c8b2781ed17574805f373e6054ff1 inherit pub_methods_classcv_1_1Algorithm"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a8ae826127fa0f1f8d10a24841bd376f8 inherit pub_methods_classcv_1_1Algorithm"><td align="right" class="memItemLeft" valign="top">virtual </td><td class="memItemRight" valign="bottom"><a class="el" href="../../d3/d46/classcv_1_1Algorithm.html#a8ae826127fa0f1f8d10a24841bd376f8">~Algorithm</a> ()</td></tr>
<tr class="separator:a8ae826127fa0f1f8d10a24841bd376f8 inherit pub_methods_classcv_1_1Algorithm"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a286fc82744ccab3d248aca44524266a9 inherit pub_methods_classcv_1_1Algorithm"><td align="right" class="memItemLeft" valign="top">virtual <a class="el" href="../../dc/d84/group__core__basic.html#ga1f6634802eeadfd7245bc75cf3e216c2">String</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="../../d3/d46/classcv_1_1Algorithm.html#a286fc82744ccab3d248aca44524266a9">getDefaultName</a> () const</td></tr>
<tr class="separator:a286fc82744ccab3d248aca44524266a9 inherit pub_methods_classcv_1_1Algorithm"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:aef2ad3f4145bd6e8c3664eb1c4b5e1e6 inherit pub_methods_classcv_1_1Algorithm"><td align="right" class="memItemLeft" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="../../d3/d46/classcv_1_1Algorithm.html#aef2ad3f4145bd6e8c3664eb1c4b5e1e6">read</a> (const <a class="el" href="../../de/dd9/classcv_1_1FileNode.html">FileNode</a> &amp;fn)</td></tr>
<tr class="memdesc:aef2ad3f4145bd6e8c3664eb1c4b5e1e6 inherit pub_methods_classcv_1_1Algorithm"><td class="mdescLeft"> </td><td class="mdescRight">Reads algorithm parameters from a file storage.  <a href="../../d3/d46/classcv_1_1Algorithm.html#aef2ad3f4145bd6e8c3664eb1c4b5e1e6">More...</a><br/></td></tr>
<tr class="separator:aef2ad3f4145bd6e8c3664eb1c4b5e1e6 inherit pub_methods_classcv_1_1Algorithm"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a0a880744bc4e3f45711444571df47d67 inherit pub_methods_classcv_1_1Algorithm"><td align="right" class="memItemLeft" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="../../d3/d46/classcv_1_1Algorithm.html#a0a880744bc4e3f45711444571df47d67">save</a> (const <a class="el" href="../../dc/d84/group__core__basic.html#ga1f6634802eeadfd7245bc75cf3e216c2">String</a> &amp;filename) const</td></tr>
<tr class="separator:a0a880744bc4e3f45711444571df47d67 inherit pub_methods_classcv_1_1Algorithm"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a1f8ad7b8add515077367fb9949a174d2 inherit pub_methods_classcv_1_1Algorithm"><td align="right" class="memItemLeft" valign="top">virtual void </td><td class="memItemRight" valign="bottom"><a class="el" href="../../d3/d46/classcv_1_1Algorithm.html#a1f8ad7b8add515077367fb9949a174d2">write</a> (<a class="el" href="../../da/d56/classcv_1_1FileStorage.html">FileStorage</a> &amp;fs) const</td></tr>
<tr class="memdesc:a1f8ad7b8add515077367fb9949a174d2 inherit pub_methods_classcv_1_1Algorithm"><td class="mdescLeft"> </td><td class="mdescRight">Stores algorithm parameters in a file storage.  <a href="../../d3/d46/classcv_1_1Algorithm.html#a1f8ad7b8add515077367fb9949a174d2">More...</a><br/></td></tr>
<tr class="separator:a1f8ad7b8add515077367fb9949a174d2 inherit pub_methods_classcv_1_1Algorithm"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a763a62d1b03042eef7d7fc3ac6c87c79 inherit pub_methods_classcv_1_1Algorithm"><td align="right" class="memItemLeft" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="../../d3/d46/classcv_1_1Algorithm.html#a763a62d1b03042eef7d7fc3ac6c87c79">write</a> (const <a class="el" href="../../dc/d84/group__core__basic.html#ga6395ca871a678020c4a31fadf7e8cc63">Ptr</a>&lt; <a class="el" href="../../da/d56/classcv_1_1FileStorage.html">FileStorage</a> &gt; &amp;fs, const <a class="el" href="../../dc/d84/group__core__basic.html#ga1f6634802eeadfd7245bc75cf3e216c2">String</a> &amp;name=<a class="el" href="../../dc/d84/group__core__basic.html#ga1f6634802eeadfd7245bc75cf3e216c2">String</a>()) const</td></tr>
<tr class="memdesc:a763a62d1b03042eef7d7fc3ac6c87c79 inherit pub_methods_classcv_1_1Algorithm"><td class="mdescLeft"> </td><td class="mdescRight">simplified API for language bindings This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.  <a href="../../d3/d46/classcv_1_1Algorithm.html#a763a62d1b03042eef7d7fc3ac6c87c79">More...</a><br/></td></tr>
<tr class="separator:a763a62d1b03042eef7d7fc3ac6c87c79 inherit pub_methods_classcv_1_1Algorithm"><td class="memSeparator" colspan="2"> </td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-static-methods"></a>
Static Public Member Functions</h2></td></tr>
<tr class="memitem:a7f1967a8334e28d8bef80fbe2f340f8c"><td align="right" class="memItemLeft" valign="top">static <a class="el" href="../../dc/d84/group__core__basic.html#ga599fe92e910c027be274233eccad7beb">cv::Scalar</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="../../d9/db5/classcv_1_1quality_1_1QualitySSIM.html#a7f1967a8334e28d8bef80fbe2f340f8c">compute</a> (<a class="el" href="../../dc/d84/group__core__basic.html#ga353a9de602fe76c709e12074a6f362ba">InputArray</a> ref, <a class="el" href="../../dc/d84/group__core__basic.html#ga353a9de602fe76c709e12074a6f362ba">InputArray</a> cmp, <a class="el" href="../../dc/d84/group__core__basic.html#gaad17fda1d0f0d1ee069aebb1df2913c0">OutputArray</a> qualityMap)</td></tr>
<tr class="memdesc:a7f1967a8334e28d8bef80fbe2f340f8c"><td class="mdescLeft"> </td><td class="mdescRight">static method for computing quality  <a href="#a7f1967a8334e28d8bef80fbe2f340f8c">More...</a><br/></td></tr>
<tr class="separator:a7f1967a8334e28d8bef80fbe2f340f8c"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a6923ba31a5e69f61f4937843d9549adf"><td align="right" class="memItemLeft" valign="top">static <a class="el" href="../../dc/d84/group__core__basic.html#ga6395ca871a678020c4a31fadf7e8cc63">Ptr</a>&lt; <a class="el" href="../../d9/db5/classcv_1_1quality_1_1QualitySSIM.html">QualitySSIM</a> &gt; </td><td class="memItemRight" valign="bottom"><a class="el" href="../../d9/db5/classcv_1_1quality_1_1QualitySSIM.html#a6923ba31a5e69f61f4937843d9549adf">create</a> (<a class="el" href="../../dc/d84/group__core__basic.html#ga353a9de602fe76c709e12074a6f362ba">InputArray</a> ref)</td></tr>
<tr class="memdesc:a6923ba31a5e69f61f4937843d9549adf"><td class="mdescLeft"> </td><td class="mdescRight">Create an object which calculates quality.  <a href="#a6923ba31a5e69f61f4937843d9549adf">More...</a><br/></td></tr>
<tr class="separator:a6923ba31a5e69f61f4937843d9549adf"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="inherit_header pub_static_methods_classcv_1_1Algorithm"><td colspan="2" onclick="javascript:toggleInherit('pub_static_methods_classcv_1_1Algorithm')"><img alt="-" src="../../closed.png"/> Static Public Member Functions inherited from <a class="el" href="../../d3/d46/classcv_1_1Algorithm.html">cv::Algorithm</a></td></tr>
<tr class="memitem:a623841c33b58ea9c4847da04607e067b inherit pub_static_methods_classcv_1_1Algorithm"><td class="memTemplParams" colspan="2">template&lt;typename _Tp &gt; </td></tr>
<tr class="memitem:a623841c33b58ea9c4847da04607e067b inherit pub_static_methods_classcv_1_1Algorithm"><td align="right" class="memTemplItemLeft" valign="top">static <a class="el" href="../../dc/d84/group__core__basic.html#ga6395ca871a678020c4a31fadf7e8cc63">Ptr</a>&lt; _Tp &gt; </td><td class="memTemplItemRight" valign="bottom"><a class="el" href="../../d3/d46/classcv_1_1Algorithm.html#a623841c33b58ea9c4847da04607e067b">load</a> (const <a class="el" href="../../dc/d84/group__core__basic.html#ga1f6634802eeadfd7245bc75cf3e216c2">String</a> &amp;filename, const <a class="el" href="../../dc/d84/group__core__basic.html#ga1f6634802eeadfd7245bc75cf3e216c2">String</a> &amp;objname=<a class="el" href="../../dc/d84/group__core__basic.html#ga1f6634802eeadfd7245bc75cf3e216c2">String</a>())</td></tr>
<tr class="memdesc:a623841c33b58ea9c4847da04607e067b inherit pub_static_methods_classcv_1_1Algorithm"><td class="mdescLeft"> </td><td class="mdescRight">Loads algorithm from the file.  <a href="../../d3/d46/classcv_1_1Algorithm.html#a623841c33b58ea9c4847da04607e067b">More...</a><br/></td></tr>
<tr class="separator:a623841c33b58ea9c4847da04607e067b inherit pub_static_methods_classcv_1_1Algorithm"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a3ba305a10d02479c13cf7d169c321547 inherit pub_static_methods_classcv_1_1Algorithm"><td class="memTemplParams" colspan="2">template&lt;typename _Tp &gt; </td></tr>
<tr class="memitem:a3ba305a10d02479c13cf7d169c321547 inherit pub_static_methods_classcv_1_1Algorithm"><td align="right" class="memTemplItemLeft" valign="top">static <a class="el" href="../../dc/d84/group__core__basic.html#ga6395ca871a678020c4a31fadf7e8cc63">Ptr</a>&lt; _Tp &gt; </td><td class="memTemplItemRight" valign="bottom"><a class="el" href="../../d3/d46/classcv_1_1Algorithm.html#a3ba305a10d02479c13cf7d169c321547">loadFromString</a> (const <a class="el" href="../../dc/d84/group__core__basic.html#ga1f6634802eeadfd7245bc75cf3e216c2">String</a> &amp;strModel, const <a class="el" href="../../dc/d84/group__core__basic.html#ga1f6634802eeadfd7245bc75cf3e216c2">String</a> &amp;objname=<a class="el" href="../../dc/d84/group__core__basic.html#ga1f6634802eeadfd7245bc75cf3e216c2">String</a>())</td></tr>
<tr class="memdesc:a3ba305a10d02479c13cf7d169c321547 inherit pub_static_methods_classcv_1_1Algorithm"><td class="mdescLeft"> </td><td class="mdescRight">Loads algorithm from a String.  <a href="../../d3/d46/classcv_1_1Algorithm.html#a3ba305a10d02479c13cf7d169c321547">More...</a><br/></td></tr>
<tr class="separator:a3ba305a10d02479c13cf7d169c321547 inherit pub_static_methods_classcv_1_1Algorithm"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ad8c591bacb34c485f5b7a250c314fc53 inherit pub_static_methods_classcv_1_1Algorithm"><td class="memTemplParams" colspan="2">template&lt;typename _Tp &gt; </td></tr>
<tr class="memitem:ad8c591bacb34c485f5b7a250c314fc53 inherit pub_static_methods_classcv_1_1Algorithm"><td align="right" class="memTemplItemLeft" valign="top">static <a class="el" href="../../dc/d84/group__core__basic.html#ga6395ca871a678020c4a31fadf7e8cc63">Ptr</a>&lt; _Tp &gt; </td><td class="memTemplItemRight" valign="bottom"><a class="el" href="../../d3/d46/classcv_1_1Algorithm.html#ad8c591bacb34c485f5b7a250c314fc53">read</a> (const <a class="el" href="../../de/dd9/classcv_1_1FileNode.html">FileNode</a> &amp;fn)</td></tr>
<tr class="memdesc:ad8c591bacb34c485f5b7a250c314fc53 inherit pub_static_methods_classcv_1_1Algorithm"><td class="mdescLeft"> </td><td class="mdescRight">Reads algorithm from the file node.  <a href="../../d3/d46/classcv_1_1Algorithm.html#ad8c591bacb34c485f5b7a250c314fc53">More...</a><br/></td></tr>
<tr class="separator:ad8c591bacb34c485f5b7a250c314fc53 inherit pub_static_methods_classcv_1_1Algorithm"><td class="memSeparator" colspan="2"> </td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pro-methods"></a>
Protected Member Functions</h2></td></tr>
<tr class="memitem:a9eb5a9b1bf6b0ad9f565bbb57dd3ca39"><td align="right" class="memItemLeft" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="../../d9/db5/classcv_1_1quality_1_1QualitySSIM.html#a9eb5a9b1bf6b0ad9f565bbb57dd3ca39">QualitySSIM</a> (<a class="el" href="../../dd/dcb/structcv_1_1quality_1_1QualitySSIM_1_1__mat__data.html">_mat_data</a> refImgData)</td></tr>
<tr class="memdesc:a9eb5a9b1bf6b0ad9f565bbb57dd3ca39"><td class="mdescLeft"> </td><td class="mdescRight">Constructor.  <a href="#a9eb5a9b1bf6b0ad9f565bbb57dd3ca39">More...</a><br/></td></tr>
<tr class="separator:a9eb5a9b1bf6b0ad9f565bbb57dd3ca39"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="inherit_header pro_methods_classcv_1_1Algorithm"><td colspan="2" onclick="javascript:toggleInherit('pro_methods_classcv_1_1Algorithm')"><img alt="-" src="../../closed.png"/> Protected Member Functions inherited from <a class="el" href="../../d3/d46/classcv_1_1Algorithm.html">cv::Algorithm</a></td></tr>
<tr class="memitem:a68eeca71617474ad3d4561786f0289d2 inherit pro_methods_classcv_1_1Algorithm"><td align="right" class="memItemLeft" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="../../d3/d46/classcv_1_1Algorithm.html#a68eeca71617474ad3d4561786f0289d2">writeFormat</a> (<a class="el" href="../../da/d56/classcv_1_1FileStorage.html">FileStorage</a> &amp;fs) const</td></tr>
<tr class="separator:a68eeca71617474ad3d4561786f0289d2 inherit pro_methods_classcv_1_1Algorithm"><td class="memSeparator" colspan="2"> </td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pro-attribs"></a>
Protected Attributes</h2></td></tr>
<tr class="memitem:a6ecb65c443c7f7ae202d9636b4e26e7e"><td align="right" class="memItemLeft" valign="top"><a class="el" href="../../dd/dcb/structcv_1_1quality_1_1QualitySSIM_1_1__mat__data.html">_mat_data</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="../../d9/db5/classcv_1_1quality_1_1QualitySSIM.html#a6ecb65c443c7f7ae202d9636b4e26e7e">_refImgData</a></td></tr>
<tr class="memdesc:a6ecb65c443c7f7ae202d9636b4e26e7e"><td class="mdescLeft"> </td><td class="mdescRight">Reference image data.  <a href="#a6ecb65c443c7f7ae202d9636b4e26e7e">More...</a><br/></td></tr>
<tr class="separator:a6ecb65c443c7f7ae202d9636b4e26e7e"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="inherit_header pro_attribs_classcv_1_1quality_1_1QualityBase"><td colspan="2" onclick="javascript:toggleInherit('pro_attribs_classcv_1_1quality_1_1QualityBase')"><img alt="-" src="../../closed.png"/> Protected Attributes inherited from <a class="el" href="../../da/d83/classcv_1_1quality_1_1QualityBase.html">cv::quality::QualityBase</a></td></tr>
<tr class="memitem:ad0b54f8924473ee99faa9972cf2da4c3 inherit pro_attribs_classcv_1_1quality_1_1QualityBase"><td align="right" class="memItemLeft" valign="top"><a class="el" href="../../da/d83/classcv_1_1quality_1_1QualityBase.html#a461c95e26223349612ce0732df7147f2">_mat_type</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="../../da/d83/classcv_1_1quality_1_1QualityBase.html#ad0b54f8924473ee99faa9972cf2da4c3">_qualityMap</a></td></tr>
<tr class="memdesc:ad0b54f8924473ee99faa9972cf2da4c3 inherit pro_attribs_classcv_1_1quality_1_1QualityBase"><td class="mdescLeft"> </td><td class="mdescRight">Output quality maps if generated by algorithm.  <a href="../../da/d83/classcv_1_1quality_1_1QualityBase.html#ad0b54f8924473ee99faa9972cf2da4c3">More...</a><br/></td></tr>
<tr class="separator:ad0b54f8924473ee99faa9972cf2da4c3 inherit pro_attribs_classcv_1_1quality_1_1QualityBase"><td class="memSeparator" colspan="2"> </td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="inherited"></a>
Additional Inherited Members</h2></td></tr>
<tr class="inherit_header pro_types_classcv_1_1quality_1_1QualityBase"><td colspan="2" onclick="javascript:toggleInherit('pro_types_classcv_1_1quality_1_1QualityBase')"><img alt="-" src="../../closed.png"/> Protected Types inherited from <a class="el" href="../../da/d83/classcv_1_1quality_1_1QualityBase.html">cv::quality::QualityBase</a></td></tr>
<tr class="memitem:a461c95e26223349612ce0732df7147f2 inherit pro_types_classcv_1_1quality_1_1QualityBase"><td align="right" class="memItemLeft" valign="top">using </td><td class="memItemRight" valign="bottom"><a class="el" href="../../da/d83/classcv_1_1quality_1_1QualityBase.html#a461c95e26223349612ce0732df7147f2">_mat_type</a> = <a class="el" href="../../d7/d45/classcv_1_1UMat.html">cv::UMat</a></td></tr>
<tr class="memdesc:a461c95e26223349612ce0732df7147f2 inherit pro_types_classcv_1_1quality_1_1QualityBase"><td class="mdescLeft"> </td><td class="mdescRight">internal mat type default  <a href="../../da/d83/classcv_1_1quality_1_1QualityBase.html#a461c95e26223349612ce0732df7147f2">More...</a><br/></td></tr>
<tr class="separator:a461c95e26223349612ce0732df7147f2 inherit pro_types_classcv_1_1quality_1_1QualityBase"><td class="memSeparator" colspan="2"> </td></tr>
</table>
<a id="details" name="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><p>Full reference structural similarity algorithm <a href="https://en.wikipedia.org/wiki/Structural_similarity">https://en.wikipedia.org/wiki/Structural_similarity</a>. </p>
</div><h2 class="groupheader">Constructor &amp; Destructor Documentation</h2>
<a id="a9eb5a9b1bf6b0ad9f565bbb57dd3ca39"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a9eb5a9b1bf6b0ad9f565bbb57dd3ca39">◆ </a></span>QualitySSIM()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname">cv::quality::QualitySSIM::QualitySSIM </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="../../dd/dcb/structcv_1_1quality_1_1QualitySSIM_1_1__mat__data.html">_mat_data</a> </td>
          <td class="paramname"><em>refImgData</em></td><td>)</td>
          <td></td>
        </tr>
      </table>
  </td>
  <td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">protected</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">
<p>Constructor. </p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">refImgData</td><td>reference image, converted to internal type </td></tr>
  </table>
  </dd>
</dl>
</div>
</div>
<h2 class="groupheader">Member Function Documentation</h2>
<a id="ac527e54b09d8f8375be2403426724709"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ac527e54b09d8f8375be2403426724709">◆ </a></span>clear()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname">void cv::quality::QualitySSIM::clear </td>
          <td>(</td>
          <td class="paramname"></td><td>)</td>
          <td></td>
        </tr>
      </table>
  </td>
  <td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">virtual</span></span>  </td>
  </tr>
</table><table class="python_language"><tr><th colspan="999" style="text-align:left">Python:</th></tr><tr><td style="width: 20px;"></td><td>None</td><td>=</td><td>cv.quality_QualitySSIM.clear(</td><td class="paramname"></td><td>)</td></tr></table>
</div><div class="memdoc">
<p>Implements <a class="el" href="../../d3/d46/classcv_1_1Algorithm.html#aec9c965448e4dc851d7cacd3abd84cd1" title="Clears the algorithm state. ">Algorithm::clear()</a> </p>
<p>Reimplemented from <a class="el" href="../../da/d83/classcv_1_1quality_1_1QualityBase.html#a6b1ecba1e463610e584e67222d59064f">cv::quality::QualityBase</a>.</p>
</div>
</div>
<a id="a49d5ecc72e83b8876c8293244c3667e4"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a49d5ecc72e83b8876c8293244c3667e4">◆ </a></span>compute() <span class="overload">[1/2]</span></h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="../../dc/d84/group__core__basic.html#ga599fe92e910c027be274233eccad7beb">cv::Scalar</a> cv::quality::QualitySSIM::compute </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="../../dc/d84/group__core__basic.html#ga353a9de602fe76c709e12074a6f362ba">InputArray</a> </td>
          <td class="paramname"><em>cmp</em></td><td>)</td>
          <td></td>
        </tr>
      </table>
  </td>
  <td class="mlabels-right">
<span class="mlabels"><span class="mlabel">virtual</span></span>  </td>
  </tr>
</table><table class="python_language"><tr><th colspan="999" style="text-align:left">Python:</th></tr><tr><td style="width: 20px;"></td><td>retval</td><td>=</td><td>cv.quality_QualitySSIM.compute(</td><td class="paramname">cmp</td><td>)</td></tr><tr><td style="width: 20px;"></td><td>retval, qualityMap</td><td>=</td><td>cv.quality_QualitySSIM.compute(</td><td class="paramname">ref, cmp[, qualityMap]</td><td>)</td></tr><tr><td style="width: 20px;"></td><td>retval, qualityMap</td><td>=</td><td>cv.quality.QualitySSIM_compute(</td><td class="paramname">ref, cmp[, qualityMap]</td><td>)</td></tr></table>
</div><div class="memdoc">
<p>Computes SSIM. </p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">cmp</td><td>Comparison image </td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd><a class="el" href="../../dc/d84/group__core__basic.html#ga599fe92e910c027be274233eccad7beb">cv::Scalar</a> with per-channel quality values. Values range from 0 (worst) to 1 (best) </dd></dl>
<p>Implements <a class="el" href="../../da/d83/classcv_1_1quality_1_1QualityBase.html#a9fb4f74d30937bbb9e88ec6b79c11c0f">cv::quality::QualityBase</a>.</p>
</div>
</div>
<a id="a7f1967a8334e28d8bef80fbe2f340f8c"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a7f1967a8334e28d8bef80fbe2f340f8c">◆ </a></span>compute() <span class="overload">[2/2]</span></h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname">static <a class="el" href="../../dc/d84/group__core__basic.html#ga599fe92e910c027be274233eccad7beb">cv::Scalar</a> cv::quality::QualitySSIM::compute </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="../../dc/d84/group__core__basic.html#ga353a9de602fe76c709e12074a6f362ba">InputArray</a> </td>
          <td class="paramname"><em>ref</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype"><a class="el" href="../../dc/d84/group__core__basic.html#ga353a9de602fe76c709e12074a6f362ba">InputArray</a> </td>
          <td class="paramname"><em>cmp</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype"><a class="el" href="../../dc/d84/group__core__basic.html#gaad17fda1d0f0d1ee069aebb1df2913c0">OutputArray</a> </td>
          <td class="paramname"><em>qualityMap</em> </td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td>
        </tr>
      </table>
  </td>
  <td class="mlabels-right">
<span class="mlabels"><span class="mlabel">static</span></span>  </td>
  </tr>
</table><table class="python_language"><tr><th colspan="999" style="text-align:left">Python:</th></tr><tr><td style="width: 20px;"></td><td>retval</td><td>=</td><td>cv.quality_QualitySSIM.compute(</td><td class="paramname">cmp</td><td>)</td></tr><tr><td style="width: 20px;"></td><td>retval, qualityMap</td><td>=</td><td>cv.quality_QualitySSIM.compute(</td><td class="paramname">ref, cmp[, qualityMap]</td><td>)</td></tr><tr><td style="width: 20px;"></td><td>retval, qualityMap</td><td>=</td><td>cv.quality.QualitySSIM_compute(</td><td class="paramname">ref, cmp[, qualityMap]</td><td>)</td></tr></table>
</div><div class="memdoc">
<p>static method for computing quality </p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">ref</td><td>reference image </td></tr>
    <tr><td class="paramname">cmp</td><td>comparison image </td></tr>
    <tr><td class="paramname">qualityMap</td><td>output quality map, or <a class="el" href="../../dc/d84/group__core__basic.html#gad9287b23bba2fed753b36ef561ae7346">cv::noArray()</a> </td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd><a class="el" href="../../dc/d84/group__core__basic.html#ga599fe92e910c027be274233eccad7beb">cv::Scalar</a> with per-channel quality values. Values range from 0 (worst) to 1 (best) </dd></dl>
</div>
</div>
<a id="a6923ba31a5e69f61f4937843d9549adf"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a6923ba31a5e69f61f4937843d9549adf">◆ </a></span>create()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname">static <a class="el" href="../../dc/d84/group__core__basic.html#ga6395ca871a678020c4a31fadf7e8cc63">Ptr</a>&lt;<a class="el" href="../../d9/db5/classcv_1_1quality_1_1QualitySSIM.html">QualitySSIM</a>&gt; cv::quality::QualitySSIM::create </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="../../dc/d84/group__core__basic.html#ga353a9de602fe76c709e12074a6f362ba">InputArray</a> </td>
          <td class="paramname"><em>ref</em></td><td>)</td>
          <td></td>
        </tr>
      </table>
  </td>
  <td class="mlabels-right">
<span class="mlabels"><span class="mlabel">static</span></span>  </td>
  </tr>
</table><table class="python_language"><tr><th colspan="999" style="text-align:left">Python:</th></tr><tr><td style="width: 20px;"></td><td>retval</td><td>=</td><td>cv.quality.QualitySSIM_create(</td><td class="paramname">ref</td><td>)</td></tr></table>
</div><div class="memdoc">
<p>Create an object which calculates quality. </p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">ref</td><td>input image to use as the reference image for comparison </td></tr>
  </table>
  </dd>
</dl>
</div>
</div>
<a id="a85d066936579d6c18aa6a981be331283"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a85d066936579d6c18aa6a981be331283">◆ </a></span>empty()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname">bool cv::quality::QualitySSIM::empty </td>
          <td>(</td>
          <td class="paramname"></td><td>)</td>
          <td> const</td>
        </tr>
      </table>
  </td>
  <td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span><span class="mlabel">virtual</span></span>  </td>
  </tr>
</table><table class="python_language"><tr><th colspan="999" style="text-align:left">Python:</th></tr><tr><td style="width: 20px;"></td><td>retval</td><td>=</td><td>cv.quality_QualitySSIM.empty(</td><td class="paramname"></td><td>)</td></tr></table>
</div><div class="memdoc">
<p>Implements <a class="el" href="../../d3/d46/classcv_1_1Algorithm.html#ab6a18f1825475643e94381697d413972" title="Returns true if the Algorithm is empty (e.g. in the very beginning or after unsuccessful read...">Algorithm::empty()</a> </p>
<p>Reimplemented from <a class="el" href="../../da/d83/classcv_1_1quality_1_1QualityBase.html#a3223929148393e56a9f01370edde82ee">cv::quality::QualityBase</a>.</p>
</div>
</div>
<h2 class="groupheader">Member Data Documentation</h2>
<a id="a6ecb65c443c7f7ae202d9636b4e26e7e"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a6ecb65c443c7f7ae202d9636b4e26e7e">◆ </a></span>_refImgData</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="../../dd/dcb/structcv_1_1quality_1_1QualitySSIM_1_1__mat__data.html">_mat_data</a> cv::quality::QualitySSIM::_refImgData</td>
        </tr>
      </table>
  </td>
  <td class="mlabels-right">
<span class="mlabels"><span class="mlabel">protected</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">
<p>Reference image data. </p>
</div>
</div>
<hr/>The documentation for this class was generated from the following file:<ul>
<li>opencv2/quality/<a class="el" href="../../d3/d49/qualityssim_8hpp.html">qualityssim.hpp</a></li>
</ul>
</div><!-- contents -->
<!-- HTML footer for doxygen 1.8.6-->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated on Fri Apr 2 2021 11:36:48 for OpenCV by  <a href="http://www.doxygen.org/index.html">
<img alt="doxygen" class="footer" src="../../doxygen.png"/>
</a> 1.8.13
</small></address>
<script type="text/javascript">
//<![CDATA[
addTutorialsButtons();
//]]>
</script>
</body>
</html>
